vcMatrixStepProperty

Typed property that holds a value, limited by a pre-defined set of values.

See in: Overview

Module: vcCore

Parent: vcProperty

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
AllowedValues	list[vcMatrix]	RW	Gets or sets a list of step values for property.
DefaultValue	vcMatrix OR None	RW	Gets or sets a default value for this property. Value None means that an explicit default value is not defined.
Magnitude	Real	RW	Gets or sets the magnitude of a property's value.
Quantity	vcQuantity	RW	Gets or sets the quantity of a property's value.
Type	vcStepPropertyType	R	Gets the type of a property.
Unit	vcUnit	R	Gets the unit of a property's value.
Value	vcMatrix	RW	Gets or sets the property value.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
waitFor	object	vcMatrix OR None value, Optional Keyword[waitTrigger = Boolean]	Blocks script execution until vcProperty.Value is equal to the "value". See more This function returns an awaitable task. It must be awaited. Parameters: value (object): Value that is used for comparison. When the value is equal to vcProperty.Value, the task completes. Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values match, the task will complete without blocking the script. Returns: Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.
waitForNot	object	vcMatrix OR None value, Optional Keyword[waitTrigger = Boolean]	Blocks script execution until vcProperty.Value is not equal to the "value". See more This function returns an awaitable task. It must be awaited. Parameters: value (object): Value that is used for comparison. When the value is not equal to vcProperty.Value, the task completes. Optional: waitTrigger (boolean): False by default. When waitTrigger is True, the task will wait for the value to change first, before comparing it against "value". Otherwise, the comparison is done immediately and when the values do not match, the task will complete without blocking the script. Returns: Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with.